home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / rbbs_pc / storydor.zip / STORYDOR.DOC < prev    next >
Text File  |  1988-11-21  |  11KB  |  260 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.                           Welcome to "The Story Door"
  9.  
  10.                       The First of Many "Cabinware Doors"
  11.  
  12.                         Brought to you by Alan Davenport
  13.  
  14.                                of Al's Cabin BBS!
  15.  
  16.                             (201) 827-7815  9600 HST
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.                            "What is a "Story Door"?"
  26.  
  27.  
  28. This door will allow you and your users to write stories online. It works
  29. like this; one person starts a story and writes a few lines. The next person
  30. who logs on then adds a few. And so on. Each user builds on the work of the
  31. previous one creating an ongoing story which is interesting reading and quite
  32. entertaining for you and your users!
  33.  
  34.  
  35.  
  36.                            "Guarantee and Disclaimer"
  37.  
  38. There is no guarantee of any kind. Reasonable care has been taken to insure
  39. there are no problems but with a door of this complexity, some may exist.
  40. Anyone running or using this door MUST agree to accept any responsibility for
  41. ANY problems that result from the use, or inability to use, this product. If
  42. you do NOT agree to this, you MUST discontinue to use this product.
  43.  
  44.  
  45.                           "Features in The Story Door"
  46.  
  47. The Story Door is an advanced story writing system for QuickBBS and RBBS
  48. 15.1C or later. It allows for great flexibility in security levels and
  49. personalization. Up to 25 different stories can be running at one time and
  50. The Story Door keeps track of the last line each user has read in each story
  51. and informs your user of what stories have new lines. I darn near had to
  52. write a complete BBS from scratch for The Story Door. It contains a complete
  53. and full-features message editor with full word wrap and line editing
  54. capabilities. Also included are "hot keys" type menus where appropriate and
  55. regular multi-character entry prompts where needed. The Story Door keeps
  56. track of loss of carrier and maintains a watch on the time your user has left
  57. so they will not exceed their time limit on your system. Six security levels
  58. exist in the door. They will be explained in detail in the section on the
  59. data file "SD-SEC.DAT". Stories can be PASSWORD PROTECTED also. Only users
  60. who know the story password or have sysop or high enough access will be able
  61. to read/write to these stories. Using the included utility program,
  62. "SD-UTIL.EXE", you can import/export stories to/from text files and LOCK OUT
  63. problem users COMPLETELY from the door!
  64.  
  65.  
  66.                                "Getting Started"
  67.  
  68. The Story door is VERY easy to set up. Even first time doors sysops should
  69. have no problem setting this door up. For QuickBBS you can either use a type
  70. 7 or type 15 exit. There is only ONE command line parameter needed for the
  71. door and that is the complete path and NAME to the DORINFO1.DEF file. (In
  72. case you do not know what this is, DORINFO1.DEF is created by both RBBS and
  73. QuickBBS whenever someone exits to a door. It contains all the information
  74. needed for door programs to run, such as user name, security level, your BBS
  75. name, etc. The reason you probably never saw this file before is because the
  76. BBS's automatically ERASE this file when the user logs off.) Below is a
  77. sample bach file for calling The Story Door from QuickBBS using a type 7 exit;
  78.  
  79.  
  80. c:
  81. cd \quickbbs\storydor
  82. storydor.exe C:\quickbbs\dorinfo1.def
  83. cd \quickbbs
  84. exit
  85.  
  86. That is all there is to it! The only change you have to make to the sample
  87. batch file batch file is to change the directories and drive letter to
  88. reflect how your system is actually set up. If you are running RBBS and
  89. running more than one node, you may use DORINFO2.DEF ..3.DEF, etc. Story Door
  90. doesnt care, it takes FROM THE COMMAND LINE the full path and NAME of the
  91. file to use as the user's information file.
  92.  
  93. I have included a file in the format of DORINFO1.DEF for local logons WITHOUT
  94. using the BBS. It is called simply "LOCAL" and you can use any text editor to
  95. edit it to add your name. To use it you change to the directory where you
  96. have The Story Door and type; "STORYDOR.EXE LOCAL".
  97.  
  98. In case you are writing an interface for BBS programs other then QuickBBS or
  99. RBBS 15.1C or later, here is a description of each line in a DORINFO1.DEF
  100. file;
  101.  
  102.  
  103. AL'S CABIN QUICKBBS           Your BBS's name
  104. ALAN                          Sysop's FIRST NAME
  105. DAVENPORT                     Sysop's LAST name
  106. COM1                          COM port in use
  107. 9600 BAUD,N,8,1               Baud rate and connect data
  108. 0                             Just a plain "0"
  109. John                          User's FIRST name
  110. Smith                         User's LAST name
  111. Your Town, USA                Users City & State
  112. 1                             Graphics mode. 1=ON, 0=OFF
  113. 10                            User's Security Level
  114. 45                            User's Time left on System
  115.  
  116.  
  117.  
  118.                                 "First Time Run"
  119.  
  120. The FIRST time you run The Story Door, it will initialize all stories with 2
  121. records. The first record is story PASSWORD and the second record is the
  122. story TITLE. Any time a story is found to be MISSING it will be automatically
  123. re-initialized. This is useful if you have a story that someone enters
  124. profanity in or if someone starts a lot of "garbage" stories. You can simply
  125. erase the offending story with no worry of harm or problems running The Story
  126. Door!
  127.  
  128. Also, when the Story Door is first run, it will initialize the SD-USERS.DAT
  129. file in which the user's name and last-line-read in each story is maintained.
  130. This file is self maintaining. If a user does not log into the door for 60
  131. days and a NEW user logs in, the inactive user's record will be over written
  132. and used for the new user.
  133.  
  134.  
  135.  
  136.                            "The Story Door Log File"
  137.  
  138. When The Story Door runs, it keeps a log of all that happens in a file called
  139. "STORYDOR.LOG". This log will show who logs on, and when, and will list what
  140. stories they have read, created, or added to and if they write to a story, it
  141. will list which one and what lines that they added. This is useful if you
  142. have someone who is entering lines of questionable quality. You will KNOW who
  143. it is and if they get too far out of hand, you can use "SD-UTIL.EXE" to LOCK
  144. THEM OUT OF THE DOOR! The log file will grow forever so keep an eye on it.
  145. You will want to periodically delete it after reading it.
  146.  
  147.  
  148.                        "The Story Door Security Levels."
  149.  
  150. There are 6 security levels in The Story Door. They are contained in the data
  151. file "SD-SEC.DAT" which can be edited with any text editor. A description of
  152. each security level is listed below;
  153.  
  154.  
  155. 1    Level to READ Stories.
  156. 5    Level to WRITE to stories.
  157. 5    Level to Create NEW stories.
  158. 10   Level to PASSWORD PROTECT a new story.
  159. 50   Level to read password protected stories WITHOUT the password.
  160. 100  Level for SYSOP'S access to Story Door.
  161.  
  162. They are fairly self explanitory. One caution is that when you edit the
  163. security levels with your editor, make darn sure you do NOT have a blank line
  164. at the top of the file! This is because the door reads in only the first 6
  165. lines. A blank line at the top of file would cause the door to assign the
  166. door security levels incorrectly!
  167.  
  168. Users with access to start new stories normally can only start one NEW story
  169. per DAY. This is kept track of in "SD-DAY.DAT"and is re-set the first run
  170. after midnight. The exception to this rule is someone with SYSOP security
  171. level. They can start as many new stories per day as they wish.
  172.  
  173. A user with SYSOP access will see TWO extra functions on the main menu. One is
  174. to LIST to Story Door log and the other is to KILL the log. This will usually
  175. be done after reading the log, to prevent it from getting too big!
  176.  
  177. Another thing visible to users with SYSOP access are the "Credits Lines" in
  178. the stories. Whenever someone adds to a story a line is added that will look
  179. something like this;
  180.  
  181. *** Addition by Alan Davenport at 04:59 on 11/15/88
  182.  
  183. These "credits lines" do NOT display to the normal users when they read the
  184. stories. They are ONLY visible to users with SYSOP access. So, if you are
  185. unfortunate enough to have a problem user, you will be immediately able to
  186. tell who it was, while THEY will think that they are being "smart", they will
  187. be marking themselves loud and clear to you, the sysop!
  188.  
  189.  
  190.  
  191.                                "The WELCOME File"
  192.  
  193. There is one more file used by the story door and it is a straight text file
  194. called "SD-WELC.TXT". This file can be (and you are ENCOURAGED to!) edited to
  195. personalize the welcome message that is displayed directly after the opening
  196. screen. In it you can put most anything you like. Suggestions for use are
  197. descriptions of certain stories, how to ask for the passwords to the
  198. protected stories, etc. Note, you do not HAVE to use this door for letting
  199. the users write stories. You can use it for on-going discussions on various
  200. topics if you wish. The "welcome" file is an excellent place to describe how
  201. you wish the door to be used.
  202.  
  203.  
  204.  
  205.                             "The "SD-DAY.DAT" File"
  206.  
  207. This file is created by The Story Door and keeps track of who creates a new
  208. story each day. It is for the door's use itself and the purpose of this file
  209. is to prevent non-sysop access users from starting more than one new story a
  210. day. It is self maintaining and you can ignore it. If you want to let a
  211. particular user make more than one new story per day, you can either delete
  212. this file or edit their name out of it.
  213.  
  214.  
  215.  
  216.                         "Distribution of The Story Door"
  217.  
  218. Your are encouraged to upload this (and any of my other) door program(s) to
  219. as many BBS's as you please.
  220.  
  221.  
  222.  
  223.                  "Support and Contributions for The Story Door"
  224.  
  225. To obtain help setting up The Story Door, give comments or suggestions, or
  226. whatever you may call my BBS at 201-827-7815 at any baud rate up to 9600-HST.
  227. PCPursuitable through the Newark, N.J. node. Alternately, you may send a
  228. netmail message to "ALAN DAVENPORT" at fidonet address 1:107/860. Any
  229. question with a REASONALBLE amount of description of the problem you are
  230. having will be answered. (An UN-reasonable message would say something like
  231. 'I can't get it to work, what's wrong?' I DO get messages like that from time
  232. to time. How on EARTH could I respond to that?!)
  233.  
  234. If you and your users enjoy The Story Door you are encouraged to send a gift
  235. of any amount ($20 recommended) to;
  236.  
  237. Alan Davenport
  238. 31 Madison Drive
  239. Ogdensburg, NJ 07439
  240.  
  241. Contributers will get preferential treatment for help and, if logged onto my
  242. BBS, will get increased time/download limits and will be given access to my
  243. "Cabinware" message area where discussion of ALL doors I have written takes
  244. place. Your increased access will be PERMENANT and not a subscription period.
  245. It will expire ONLY after you have been off my system for over 60 days, when
  246. you will be purged from inactivity. (So, if you are a regular caller, your
  247. increased access will NEVER expire!)
  248.  
  249. Please DO consider a gift, even if you do NOT call my system. I almost had to
  250. write a complete BBS from scratch to get the menus and message entry/edit
  251. section working! An occational gift will let me know all my hard work is
  252. appreciated and will encourage me to write even MORE doors for you and your
  253. users' enjoyment!
  254.  
  255. Take care now,
  256. Alan Davenport
  257. 11/21/88 2:59 Am
  258. 201-827-7815 BBS 9600HST
  259.  
  260.